Split readme docs #114
Split readme docs #114
Conversation
…x docs with generated md files
…ebooks and config files
.github/workflows/docs.yml
Outdated
| pip install -e .[docs] | ||
| - name: Split README into sections | ||
| run: | | ||
| python docs/split_readme.py |
There was a problem hiding this comment.
This will not be done on Sphinx though!
There was a problem hiding this comment.
I tried to preprocess he md files first, and then use them in the Sphinx index, is it not the correct way to do it?
There was a problem hiding this comment.
Yes it's correct. but I wanted to highlight that this has no effect on sphinx. We can have a look at it together tomorrow.
|
This PR closes #79 |
There was a problem hiding this comment.
Is the sphinx-apidoc command here also needed considering it's also done on the sphinx conf.py?
There was a problem hiding this comment.
This action just tests that the execution works. As the index.md expects some file under references, it is needed here.
|
Do you want to keep the folder |
docs/sections_readme/case_studies.md
Outdated
|
|
||
| VueGen’s functionality is demonstrated through two case studies: | ||
|
|
||
| **1. Predefined Directory** |
There was a problem hiding this comment.
Maybe you want to add headlines here?
docs/sections_readme/case_studies.md
Outdated
| @@ -0,0 +1,58 @@ | |||
| ## Case studies | |||
There was a problem hiding this comment.
It could be that sphinx will complain about the headlines. Check the logs, but if you split up the README, you could remove one hashtag per headline...
That said, the website looks good, so no big issue
docs/sections_readme/citation.md
Outdated
| @@ -0,0 +1,22 @@ | |||
| ## Citation | |||
There was a problem hiding this comment.
and it's everywhere in your dumps
… contact to the docs
No description provided.